Telegram Bot/eu.vendeli.tgbot.api.stickerset

Package-level declarations

Types

class AddStickerToSetAction(userId: Long, name: String, sticker: InputSticker) : SimpleAction<Boolean>

class CreateNewStickerSetAction(userId: Long, name: String, title: String, stickers: List<InputSticker>) : SimpleAction<Boolean> , OptionsFeature<CreateNewStickerSetAction, CreateNewStickerSetOptions>

DeleteStickerFromSetAction

class DeleteStickerFromSetAction(sticker: String) : SimpleAction<Boolean>

DeleteStickerSetAction

class DeleteStickerSetAction(name: String) : SimpleAction<Boolean>

GetCustomEmojiStickersAction

class GetCustomEmojiStickersAction(customEmojiIds: List<String>) : SimpleAction<List<Sticker>>

GetStickerSetAction

class GetStickerSetAction(name: String) : SimpleAction<StickerSet>

ReplaceStickerInSetAction

class ReplaceStickerInSetAction(userId: Long, name: String, oldSticker: String, sticker: InputSticker) : Action<Boolean>

SetCustomEmojiStickerSetThumbnailAction

class SetCustomEmojiStickerSetThumbnailAction(name: String, customEmojiId: String? = null) : SimpleAction<Boolean>

SetStickerEmojiListAction

class SetStickerEmojiListAction(sticker: String, emojiList: List<String>) : SimpleAction<Boolean>

SetStickerKeywordsAction

class SetStickerKeywordsAction(sticker: String, keywords: List<String>? = null) : SimpleAction<Boolean>

SetStickerMaskPositionAction

class SetStickerMaskPositionAction(sticker: String, maskPosition: MaskPosition? = null) : SimpleAction<Boolean>

SetStickerPositionInSetAction

class SetStickerPositionInSetAction(sticker: String, position: Int) : SimpleAction<Boolean>

SetStickerSetThumbnailAction

class SetStickerSetThumbnailAction(name: String, userId: Long, format: StickerFormat, thumbnail: ImplicitFile? = null) : SimpleAction<Boolean>

SetStickerSetTitleAction

class SetStickerSetTitleAction(name: String, title: String) : SimpleAction<Boolean>

UploadStickerFileAction

class UploadStickerFileAction(userId: Long, sticker: InputFile, stickerFormat: StickerFormat) : SimpleAction<File>

Functions

addStickerToSet

inline fun addStickerToSet(userId: Long, name: String, input: InputSticker): AddStickerToSetAction

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

inline fun addStickerToSet(userId: Long, name: String, input: () -> InputSticker): AddStickerToSetAction

createNewStickerSet

inline fun createNewStickerSet(userId: Long, name: String, title: String, stickers: List<InputSticker>): CreateNewStickerSetAction

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

deleteStickerFromSet

inline fun deleteStickerFromSet(sticker: String): DeleteStickerFromSetAction

Use this method to delete a sticker from a set created by the bot. Returns True on success.

deleteStickerSet

inline fun deleteStickerSet(name: String): DeleteStickerSetAction

Use this method to delete a sticker set that was created by the bot. Returns True on success.

getCustomEmojiStickers

@JvmName(name = "getCustomEmojiStickersWithVararg")

inline fun getCustomEmojiStickers(vararg customEmojiId: String): GetCustomEmojiStickersAction

inline fun getCustomEmojiStickers(customEmojiIds: List<String>): GetCustomEmojiStickersAction

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

getStickerSet

inline fun getStickerSet(name: String): GetStickerSetAction

Use this method to get a sticker set. On success, a StickerSet object is returned.

replaceStickerInSet

inline fun replaceStickerInSet(userId: Long, name: String, oldSticker: String, sticker: InputSticker): ReplaceStickerInSetAction

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

setCustomEmojiStickerSetThumbnail

inline fun setCustomEmojiStickerSetThumbnail(name: String, customEmojiId: String? = null): SetCustomEmojiStickerSetThumbnailAction

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

setStickerEmojiList

inline fun setStickerEmojiList(sticker: String, emojiList: List<String>): SetStickerEmojiListAction

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

setStickerKeywords

inline fun setStickerKeywords(sticker: String, keywords: List<String>? = null): SetStickerKeywordsAction

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

setStickerMaskPosition

inline fun setStickerMaskPosition(sticker: String, maskPosition: MaskPosition? = null): SetStickerMaskPositionAction

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

setStickerPositionInSet

inline fun setStickerPositionInSet(sticker: String, position: Int): SetStickerPositionInSetAction

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

setStickerSetThumbnail

inline fun setStickerSetThumbnail(name: String, userId: Long, format: StickerFormat, thumbnail: ImplicitFile? = null): SetStickerSetThumbnailAction

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

setStickerSetTitle

inline fun setStickerSetTitle(name: String, title: String): SetStickerSetTitleAction

Use this method to set the title of a created sticker set. Returns True on success.

uploadStickerFile

inline fun uploadStickerFile(userId: Long, sticker: InputFile, stickerFormat: StickerFormat): UploadStickerFileAction

Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.